home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / dev / misc / gadoc.lha / GAdoc.c / readme < prev   
Encoding:
Text File  |  1995-03-28  |  2.0 KB  |  77 lines
  1. GAdoc Version 1.2
  2. -----------------
  3.  
  4. This software is subject to the ``Standard Amiga FD-Software Copyright Note''
  5. It is Cardware as defined in paragraph 4.c.
  6. If you like it and use it regularly please send a postcard to the author.
  7. For more information please read ``AFD-COPYRIGHT'' (Version 1 or higher).
  8.  
  9.  
  10. This program extracts the autodocs from your source codes and generates
  11. a texinfo file out of it.
  12.  
  13. What makes this program different from ``autodoc'' [(c) Commodore] is
  14. that it generates a texinfo file.
  15. This has several advantages:
  16.  
  17.     Easy to generate a hypertext out of it (makeinfo)
  18.  
  19.     Easy to generate a .dvi file (Using TeX)
  20.  
  21.     Easy to generate plain ASCII text (makeinfo)
  22.  
  23. GAdoc is very easy to use, just open a shell and enter the following
  24.  
  25.  
  26.     gadoc <source> <dest> [options]
  27.  
  28.  
  29. This will extract the autodocs from <source> and generate two new files
  30. <dest>.menu and <dest>.data, where <dest>.menu is the main part.
  31.  
  32.  
  33. Options:
  34.  
  35.          -i:     Also extract internal documentation
  36.          -c:     Convert \* to /* and *\ to */
  37.          -amiga: Include amiga support for texinfo
  38.          -aicon: Generate an icon for the Amiga workbench (GUI)
  39.          -s<ID>: Only extract entries that have a special ID, default
  40.          ID is "**".
  41.  
  42.  
  43. Please read the documentation for further details.
  44. Check the file ``2PagesTexi.scr'', if you want to use gadoc in
  45. combination with TeX; it makes a booklet out of your .dvi file.
  46.  
  47. This program was inspired by Robodoc 0.92:
  48.  
  49.  
  50. ROBODoc v0.92 is written by Jacco van Weert.
  51.  
  52.     Email:    weertj@euronet.nl
  53.  
  54.     or
  55.  
  56.     Maverick Software Development, T.a.v. J.v.Weert
  57.     Haverdreef 131,
  58.     7006 LH, Doetinchem.
  59.     The Netherlands.
  60.  
  61.  
  62. Well, Robodoc didn't work very well with my CLisp source files, so I wrote
  63. my own program.
  64.  
  65.  
  66. GADOC and NON-AMIGA systems
  67. ---------------------------
  68.  
  69. The .info files contain the icon information for the amiga workbench
  70. (graphical user interface). You may delete them, BUT NOT IF YOU WANT TO
  71. RE-DISTRIBUTE gadoc!
  72.  
  73.  
  74. Gerhard Leibrock, Neuhäuselerstr. 12, 66459 Kirkel, Germany
  75.  
  76. March 1995
  77.